home *** CD-ROM | disk | FTP | other *** search
/ ShareWare OnLine 2 / ShareWare OnLine Volume 2 (CMS Software)(1993).iso / bbs_soft / sfnattrv.zip / SFNATTRV.DOC < prev    next >
Text File  |  1993-05-23  |  20KB  |  494 lines
  1.  
  2.  
  3.                              F R E E W A R E
  4.  
  5.                                  f r o m
  6.  
  7.   ───═════ ╓─────┐ ╓─┐    ╓─────┐ ╓─────┐ ╓─────┐ ╓──────┐ ╓───┐ ╓─────┐
  8.   ──══════ ║ ┌───┘ ║ │    ║ ┌───┘ ║ ┌─╖ │ ╙─╖ ┌─┘ ║ ┌──╖ │ ╙╖ ┌┘ ║ ┌─╖ │
  9.   ───═════ ║ └─┐   ║ │    ║ └─┐   ║ │ ╙─┘   ║ │   ║ └──╜ │  ║ │  ║ │ ╙─┘
  10.     ──════ ║ ┌─┘   ║ │    ║ ┌─┘   ║ │ ╓─┐   ║ │   ║ ┌─╖ ┌┘  ║ │  ║ │ ╓─┐
  11.        ─══ ║ └───┐ ║ └──┐ ║ └───┐ ║ └─╜ │   ║ │   ║ │ ║ └┐ ╓╜ └┐ ║ └─╜ │
  12.         ─═ ╙─────┘ ╙────┘ ╙─────┘ ╙─────┘   ╙─┘   ╙─┘ ╙──┘ ╙───┘ ╙─────┘
  13.      ─═══════ ╓─┐ ╓──┐ ╓───┐  ╓─┐ ╓───┐ ╓──────┐ ╓─┐ ╓─┐ ╓─────┐ ╓─────┐
  14.     ───══════ ║ │╓╜ ┌┘ ║   └┐ ║ │ ╙╖ ┌┘ ║ ┌────┘ ║ │ ║ │ ╙─╖ ┌─┘ ║ ┌───┘
  15.       ──═════ ║ └╜ └─┐ ║ ├╖ └┐║ │  ║ │  ║ │ ╓──┐ ║ └─╜ │   ║ │   ║ └───┐
  16.         ─════ ║ ┌──╖ │ ║ │╙╖ └╢ │  ║ │  ║ │ ╙╖ │ ║ ┌─╖ │   ║ │   ╙───╖ │
  17.          ─═══ ║ │  ║ │ ║ │ ╙╖   │ ╓╜ └┐ ║ └──╜ │ ║ │ ║ │   ║ │   ╓───╜ │
  18.           ─══ ╙─┘  ╙─┘ ╙─┘  ╙───┘ ╙───┘ ╙──────┘ ╙─┘ ╙─┘   ╙─┘   ╙─────┘
  19.    ─═══ ┌┬────.                                 ╓──┐ ╥  ┬ ╥──┐  ╓─┐  ╓─┐
  20.   ─════ ││     \           \ │ /                ║    ╟──┤ ╟─    ╙─┐  ╙─┐
  21.    ─═══ ││      └──────┬┬┬┬┬┬┬┬.        │       ╙──┘ ╨  ┴ ╨──┘ ╙──┘ ╙──┘
  22.   ──════'│─════       ─┴─────────══════.│                 ╥─┐  ╥─┐   ╓─┐
  23.     ─════ \   SFv3.3   ┌┬──────.     ╧  ╞╞─               ╟─┴┐ ╟─┴┐  ╙─┐
  24.        ─══ '─═════════╧╧╧╧═════╧════╧══'│                 ╨──┘ ╨──┘ ╙──┘
  25.    Brants FIRST registered SPITFIRE BBS │    RelayNet(tm) Node: ELECTRIK
  26.        ═════════ SF330279 ═════════                              #1001
  27.     SPITFIRE + BBS-CHESS + ChessCOM + RelayNet(tm) = The BEST in Chess!
  28.    ░░░░░░░░░░░░░░░░▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓█████████████
  29.  
  30.  
  31.                      2400 * 8/N/1 * (519) 442-6449
  32.  
  33.  
  34.                            in cooperation with
  35.                           Buffalo Creek Software
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.                                  SFNATTRV
  58.                   SPITFIRE NATURAL SCIENCE TRIVIA DOOR
  59.                                 Version 1.0
  60.                                    by
  61.                                Derek Mann
  62.                                    of
  63.                        Electric Knights Chess BBS
  64.  
  65.  
  66.    INTRODUCTION
  67.    ------------
  68.  
  69.    SFNATTRV is a fast paced natural science trivia game designed to run
  70.    as a door feature within the SPITFIRE Bulletin Board System.  It can
  71.    also be installed as a sysop configurable command from the Main, File
  72.    or Message menus of SPITFIRE.  A data file containing over 300
  73.    natural science trivia questions is randomly accessed and displayed
  74.    to the screen. With each question that is displayed, four multiple
  75.    choice options are provided from which the player may select.
  76.  
  77.    SFNATTRV allows the SYSOP to configure the delay time (defaults to
  78.    ten seconds) that the player is allowed to read the question and
  79.    respond with the number corresponding to the answer they wish to
  80.    select.
  81.  
  82.  
  83.    SFNATTRV COMMAND LINE PARAMETERS
  84.    --------------------------------
  85.  
  86.       /P - Designates the drive, path, filename and extension of the
  87.            high score bulletin to be used with SFNATTRV
  88.  
  89.       /D - Designates the delay time (in seconds) that the user is
  90.            allowed to answer the question before it "times out".
  91.  
  92.       /L - Allows local usage of SFNATTRV
  93.  
  94.  
  95.    The /P command line parameter is available which will automatically
  96.    create Ansi and Non-Ansi high score bulletins for your BBS system.
  97.    If you would like to use this option, a "/P" should follow the
  98.    SFNATTRV in the command line to indicate a valid DOS path where the
  99.    bulletin file will be created.  (NOTE: This should be the same as the
  100.    display file path you have set up within SPITFIRE.)  The path is then
  101.    followed by the file name of the bulletin to be created.  It is not
  102.    necessary to include the file extension.  SFNATTRV will automatically
  103.    add a .BBS extension for the Non-Ansi display file and a .CLR
  104.    extension for the Ansi display file created.  The correct syntax
  105.    should look like this:
  106.  
  107.    SFNATTRV /P C:\SF\DISPLAY\DORBUL1
  108.  
  109.    The "/P" command line is optional and SFNATTRV will operate perfectly
  110.    fine without it.  However, it is a convenient means of providing and
  111.    posting high score bulletins for the natural science trivia door.
  112.  
  113.  
  114.    The /D command line parameter is also available which will allow the
  115.    Sysop to designate the delay time (in seconds) that is allowed
  116.    between the time the question prompt is displayed to the screen and
  117.    when the user must enter the desired answer.  This is done using the
  118.    /Dnn (where nn represents the number of seconds) command line
  119.    parameter.  As an example, if the Sysop wishes to allow a 15 second
  120.    delay, a /D15 would be entered on the command line as illustrated
  121.    below:
  122.  
  123.    SFNATTRV /D15
  124.  
  125.    If no /Dnn is designated at the command line, SFNATTRV will default
  126.    to a ten second delay.
  127.  
  128.  
  129.    The /L command line parameter will allow SFNATTRV to be played
  130.    locally without requiring a SFDOORS.DAT, SFMAIN.DAT, SFMESS.DAT or
  131.    SFFILE.DAT file.  Using the /L command line parameter disables the
  132.    program's carrier detect monitoring and redirection of the game
  133.    through the comm port.  For local operation of SFNATTRV enter the
  134.    following command at the DOS prompt:
  135.  
  136.    C:> SFNATTRV /L
  137.  
  138.    ** SPECIAL NOTE ** The /L, /P and /D command parameters can be used
  139.    together in one command line to specify the drive, path and filename
  140.    of the bulletin to be created and the delay time in seconds when
  141.    playing in local mode.
  142.  
  143.    It should also be noted that the /P, /D and /L command line
  144.    parameters may appear in any order on the command line.  SFNATTRV
  145.    does NOT require these to be used in a specific order.
  146.  
  147.  
  148.  
  149.    SFNATTRV SETUP AS A SPITFIRE DOOR
  150.    ---------------------------------
  151.  
  152.    To set up SFNATTRV to be executed as a door, it is recommended that a
  153.    separate directory be set up for it.  For explanation purposes, let's
  154.    assume the directory DOORA is created for use with SFNATTRV.  The
  155.    following files must then be placed in the directory:
  156.  
  157.    SFNATTRV.EXE    The actual game program.
  158.  
  159.    SFNATTRV.DAT    The data file containing the trivia questions.
  160.  
  161.    SFNATTRV.TOP    This is a listing of the top ten players.  SFNATTRV.EXE
  162.                    will create this file if it is not found.
  163.  
  164.    SFNATTRV.LMT    This allows you to set time limits according to the
  165.                    callers security level.
  166.  
  167.    The Sysop will then need to use a text editor to edit the SF.BAT file
  168.    as illustrated below:
  169.  
  170.    :DOOR_A
  171.    COPY SFDOORS.DAT C:\SF\DOORA
  172.    SFNATTRV
  173.    ERASE SFDOORS.DAT
  174.    GOTO LOOP
  175.    :DOOR_B
  176.  
  177.  
  178.    You will notice that the commands needed to execute SFNATTRV are
  179.    placed between the :DOOR_A and GOTO LOOP command lines.  These are
  180.    entered in place of the existing REM Place Program Name Here.  The
  181.    following will briefly explain each of the commands which were set up
  182.    within SF.BAT to run SFNATTRV as a SPITFIRE Door program:
  183.  
  184.    SFDOORS.DAT is created automatically by SPITFIRE when a user enters a
  185.    door.  It contains information about the user such as name and
  186.    password.  SFNATTRV requires access to the information within
  187.    SFDOORS.DAT.  Therefore, before executing the program it must be
  188.    copied to the directory in which SFNATTRV is running.
  189.  
  190.    SFNATTRV is the program name and executes the game program from
  191.    within the door program.
  192.  
  193.    Once the user has terminated the game play of SFNATTRV, SPITFIRE
  194.    erases the SFDOORS.DAT file.
  195.  
  196.  
  197.  
  198.    SFNATTRV SETUP AS A SYSOP CONFIGURABLE COMMAND
  199.    ----------------------------------------------
  200.  
  201.    SPITFIRE has a sysop configurable command for the Main, Message and
  202.    File menus.  The sysop configurable command is executed through a
  203.    batch file which corresponds to the menu it is being run from.  In
  204.    other words, SFMAIN.BAT runs the sysop configurable command from the
  205.    Main Menu, SFMESS.BAT runs the one from the Message Menu and
  206.    SFFILE.BAT the one from the File Menu.  The commands necessary to
  207.    execute SFNATTRV can be set up in the batch file which corresponds to
  208.    the menu you wish to have SFNATTRV run from.
  209.  
  210.    The first thing you will need to establish is which of these menus
  211.    you wish to use to run SFNATTRV.  For this purpose, let's assume that
  212.    it is going to be set up so it can be run from the Main Menu.  (It
  213.    should be noted the set up procedure is the same regardless of which
  214.    Menu you are running SFNATTRV from.)
  215.  
  216.    Next, you will need to decide what you wish to name the command
  217.    option and establish what security level will be required for users
  218.    of your system to be able to access this option.  Once this is
  219.    determined you will need to modify the SFMAIN.MNU file using your
  220.    favorite text editor, as long as it saves in ASCII format.  (Refer to
  221.    the SPITFIRE manual for further documentation on this if needed.  It
  222.    should also be noted that if SFNATTRV were being set up to run from
  223.    the File Menu, you would need to modify the SFFILE.MNU file and if it
  224.    was being set up to be run from the Message Menu you would need to
  225.    modify the SFMSG.MNU file.)
  226.  
  227.  
  228.    Examining the default SFMAIN.MNU file, you will notice the sysop
  229.    configurable command appears as:
  230.  
  231.         <K>............. Add Your Own,,1000,@
  232.  
  233.  
  234.    This will need to be replaced with a Command Character that will be
  235.    used to select the option from the menu.  It is ABSOLUTELY IMPERATIVE
  236.    that the Command Character must not duplicate an existing Command
  237.    Character for another menu option.  You will then need to include a
  238.    brief description of the Wildcat door program you are running, two
  239.    commas, the security level required to access this feature, and
  240.    another comma followed by the a @.  The @ must not be changed!  (For
  241.    more detailed information on modifying your SFMAIN.MNU, SFMSG.MNU or
  242.    SFFILE.MNU refer to your SPITFIRE manual.)
  243.  
  244.        <K>.... Brief Program Description,,10,@
  245.  
  246.    Now you will need to modify the corresponding batch file, SFMAIN.BAT,
  247.    so that it can be executed from the Main Menu.  Do this using your
  248.    favorite text editor, as long as it saves in ASCII format.  (Again,
  249.    it should be noted that if SFNATTRV were being set up to run from the
  250.    File Menu, you would need to modify the SFFILE.BAT file and if it was
  251.    being set up to be run from the Message Menu you would need to modify
  252.    the SFMESS.BAT file.)
  253.  
  254.    Place the SFNATTRV.EXE file in the directory you wish to run the
  255.    program from.  SFNATTRV will create its own player score file,
  256.    SFNATTRV.TOP, if does not already exist.
  257.  
  258.    The commands set up in the SFMAIN.BAT file are very similar to those
  259.    used for executing the game through a door in the SF.BAT file.  For
  260.    instance, if you were running SFNATTRV from the main SPITFIRE
  261.    directory your SFMAIN.BAT file might look like this:
  262.  
  263.        ECHO OFF
  264.        BRK OFF
  265.        SFNATTRV
  266.        BRK ON
  267.  
  268.    (BRK is not included in the SFNATTRV package because it is written
  269.    and copyrighted by Solid Systems, 1985, but can be downloaded from
  270.    The Mother Board BBS and Buffalo Creek's BBS as well as a number of
  271.    other BBS systems.  BRK is not required to run SFNATTRV, however, it
  272.    is recommended since it will prevent a user using the CTRL BRK
  273.    command to terminate the batch file, gaining access to your system at
  274.    the DOS level.)
  275.  
  276.    If you wish to set SFNATTRV up in a separate subdirectory from
  277.    SPITFIRE, for instance, a subdirectory named SFNATTRV, your batch
  278.    file might look like this.
  279.  
  280.        ECHO OFF
  281.        BRK OFF
  282.        COPY SFMAIN.DAT \SF\SFNATTRV
  283.        CD \SF\SFNATTRV
  284.        SFNATTRV
  285.        ERASE SFMAIN.DAT
  286.        CD \SF
  287.        BRK ON
  288.  
  289.  
  290.    When SFNATTRV is executed, from either the door with the SF.BAT file
  291.    or from the sysop configurable command through a menu with the
  292.    corresponding batch file, it will first look for the SFMAIN.DAT file,
  293.    then the SFMESS.DAT file, then the SFFILE.DAT file and lastly the
  294.    SFDOORS.DAT file.  It will look for each of these files until it
  295.    finds it and the commands required for its execution.  If none of
  296.    these files are found, SFNATTRV will halt its execution.
  297.  
  298.  
  299.    DTE LOCK FEATURE
  300.    ----------------
  301.  
  302.    SFNATTRV automatically detects if the DTE is locked at 19200 baud.
  303.    If SFNATTRV detects that the DTE is locked, then SFNATTRV opens the
  304.    serial port to the maximum baud rate of your system.  If SFNATTRV
  305.    does not detect that the DTE is locked, then the serial port is
  306.    opened to the baud rate of the caller.
  307.  
  308.  
  309.    SFNATTRV ON A MULTI-NODE SYSTEM
  310.    -------------------------------
  311.  
  312.    SFNATTRV is fully compatible for operation on a multi-node BBS.  It
  313.    automatically handles any file locking and file sharing required
  314.    during the doors execution.
  315.  
  316.  
  317.    SYSOP FEATURES
  318.    --------------
  319.  
  320.    First, a status line is now displayed on the BBS monitor that
  321.    provides information concerning the caller's name, baud rate of the
  322.    caller and the security level of the caller.
  323.  
  324.    A SFNATTRV.LMT file allows the sysop to establish a time limit for
  325.    door play according to the security level the caller has on the
  326.    system.  To modify the accompanying SFNATTRV.LMT file, use your
  327.    favorite text editor to represent the various security levels you
  328.    have available on your system, a comma then the corresponding time
  329.    you wish to allow for that particular security level in minutes.  For
  330.    instance, it might look like this:
  331.  
  332.    10,15
  333.    25,20
  334.    50,25
  335.    999,30
  336.  
  337.    Each security level should begin a new line and you should have a
  338.    setting for each security level you have available on your system.
  339.    If you do not have a time limit set for a particular security SFNATTRV
  340.    will default to the level 10 security level setting.
  341.  
  342.    Pressing the Shift Key and the F1 key simultaneously will terminate
  343.    game play of SFNATTRV and return the caller back to the BBS.
  344.    Pressing the Shift Key and the F9 key simultaneously will terminate
  345.    game play of SFNATTRV and log the caller off of the BBS.  If the
  346.    Shift Key and the F9 key are pressed together, logging the caller off
  347.    the BBS, SPITFIRE will recycle and return to the SPITFIRE Ready For
  348.    Caller Prompt.
  349.  
  350.  
  351.    SFNATTRV EXECUTION
  352.    ------------------
  353.  
  354.    When first executed, SFNATTRV will display a list of the Top Ten high
  355.    score players and the percentage of correct responses they achieved
  356.    while playing SFNATTRV.  Initially, this will be a dummy listing with
  357.    ten lines that display:
  358.  
  359.       0%...............YOUR NAME COULD BE HERE
  360.  
  361.    However, as the game is played, this will fill with the name of the
  362.    players, their percentage ratings and the date that the player was
  363.    added to the top ten listing.
  364.  
  365.    NOTE: At least twenty questions must be attempted before SFNATTRV
  366.          will will figure the percentage rating for the player.
  367.  
  368.    To keep things interesting...the Sysop can erase the file which
  369.    contains the top ten listings SFNATTRV.TOP on a routine basis to give
  370.    additional players a chance to have their name added to the list.
  371.  
  372.    As the top ten list is displayed, at the bottom of the screen is a
  373.    question which prompts the user whether they want to have ANSI
  374.    Graphics (y/n)?  available to them during game play.  If the user
  375.    responds with a y (for yes) the game will display in color and if the
  376.    user responds with a n (for no) the game will display in monochrome.
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.    PLAYING SFNATTRV
  392.    ----------------
  393.  
  394.    Immediately after pressing any key (other than <Q> for Quit) from the
  395.    Top Ten listing the game screen is displayed.  The screen will look
  396.    like the following:
  397.  
  398.    ---------------------------------------------------------------------
  399.  
  400.     ╔═════════════════════════════════════════════╗
  401.     ║   >>>>>> NATURAL SCIENCE TRIVIA <<<<<<<<<   ║
  402.     ║                 Version 1.0                 ║
  403.     ║ Natural Science Trivia Door For SPITFIRE!   ║
  404.     ║    Electric Knights BBS * (519) 442-6449    ║
  405.     ║ In Cooperation with Buffalo Creek Software  ║
  406.     ║     Copyright (C) by Derek Mann, 1993       ║
  407.     ╚═════════════════════════════════════════════╝
  408.  
  409.     RIGHT: 0                        WRONG: 0
  410.  
  411.     QUESTION:
  412.     The Natural science trivia question will be displayed
  413.     here.
  414.  
  415.     <1> Choice 1                        <2> Choice 2
  416.     <3> Choice 3                        <4> Choice 4
  417.  
  418.              Enter Answer: [ 1 2 3 4 <Q>uit]?
  419.  
  420.    ---------------------------------------------------------------------
  421.    The first randomly chosen trivia question is selected from the data
  422.    file and is displayed to the screen.
  423.  
  424.    The player makes his selection by entering the corresponding number.
  425.    As the game progresses, SFNATTRV will provide a running total of the
  426.    correct answers and also of the wrong answers the user has selected
  427.    during the game play.
  428.  
  429.    If the ten second timer should elapse before you respond, SFNATTRV
  430.    will count this as a wrong response and add an incorrect answer to
  431.    the total WRONG answers obtained so far.
  432.  
  433.  
  434.    EXITING PLAY
  435.    ------------
  436.  
  437.    When you are ready to exit the game, simply select press "Q" for
  438.    <Q>uit.  If you qualify as one of the top ten players to date,
  439.    SFNATTRV will congratulate you for becoming one of the top ten
  440.    scorers and add your name to the Top Ten listing.  You will once
  441.    again see the Top Ten list displayed with your name added to the
  442.    list.
  443.  
  444.    If you exit the game before you have completed the twenty questions
  445.    required for eligibility to the Top Ten list or if you do not qualify
  446.    as a Top Ten player, the Top Ten listing will be displayed and you
  447.    will be prompted to press any key to return to SPITFIRE.
  448.  
  449.  
  450.    DISTRIBUTION
  451.    ------------
  452.  
  453.    Please feel free to share SFNATTRV.ZIP with others.  However, it must
  454.    be distributed with SFNATTRV.EXE, SFNATTRV.DAT, SFNATTRV.TOP,
  455.    SFNATTRV.LMT and the SFNATTRV.DOC in the SFNATTRV.ZIP distribution
  456.    package.  The files must not be altered in any way or by any means.
  457.  
  458.  
  459.    PUBLIC DOMAIN - DISCLAIMER
  460.    --------------------------
  461.  
  462.    SFNATTRV is distributed under the public domain concept.  The
  463.    software and its accompanying documentation are provided "as is"
  464.    without warranties expressed or implied as to the performance or
  465.    merchantability.  No registration fee is required and the program can
  466.    be distributed freely.  However, by the use of SFNATTRV, the user
  467.    assumes all responsibilities and agrees that Derek Mann or
  468.    Electric Knights BBS or Bill Brown shall not be held liable for any
  469.    damage incurred to hardware, software or peripheral devices while
  470.    running same.
  471.  
  472.    Many thanks are indeed owed to Mike Woltz of Buffalo Creek BBS (515)-
  473.    225-8496 for his assistance.  Without his help this program would not
  474.    have been possible.
  475.  
  476.    DEDICATION:
  477.    This game is given freely to the SPITFIRE community to encourge and
  478.    foster the spirit of the SPITFIRE project.
  479.  
  480.    History
  481.    -------
  482.  
  483.    Release 1    SFNATTRV released.
  484.  
  485.  
  486.  
  487.    SFNATTRV and other SPITFIRE programs are available for download from:
  488.  
  489.         Buffalo Creek BBS                 Electric Knights Chess BBS
  490.         Sysop - Mike Woltz                   Sysop - Bill Brown
  491.           (515) 225-8496                        (519) 442-6449
  492.        19200/9600/2400/1200                      2400/8/N/1
  493.  
  494.